0%

GitHubのpull requestを綺麗に書く。

20241017_050333.png

どうゆうこと?

正式な表記で書く。

  1. 例 : eslint → × ESLint → ⭕️
  2. 例 : gitHub → × GitHub → ⭕️

どうして?

チャットみたいな即時的なコミュニケーションの場合は、正式な表記じゃなくても別にいいが、文章として残るものに関しては注意して書くべき。

どうすれば?

自分の書いたコードを正しく説明記載できるように理解する、使用している技術を正しく理解する。

よくやってしまうのが、コピぺだけして動いて満足する事。

すでに出来上がったコードをコピペして終わりではなく、なぜ使用するのか、どうゆう処理をするのかをここで正しく理解するようにする。

まとめ

自分がなぜそう実装したのかをきちんと『書ける、話せること』で
pull requestを綺麗に書く事ができて、
他プロジェクトに参加した場合でも、レビュアーの負担を減らすことができて良きかなと思います。